Skip to content

Improve Application Memory Documentation#3739

Open
benjaminach wants to merge 11 commits into
masterfrom
feat/oom-crash
Open

Improve Application Memory Documentation#3739
benjaminach wants to merge 11 commits into
masterfrom
feat/oom-crash

Conversation

@benjaminach
Copy link
Copy Markdown
Contributor

@benjaminach benjaminach commented May 5, 2026

This PR improves the documentation around application memory usage on Scalingo.

It clarifies how memory, swap, container sizes, metrics, and runtime crashes relate to each other, and moves the OOM crash explanation to the Runtime Issues page where it better fits troubleshooting workflows.

It also adds language-specific memory management pointers for Go, Java, Node.js, PHP, Python, and Ruby, so users can find the main runtime settings that influence memory usage.

Changes

  • Add memory management guidance to supported language introduction pages.
  • Move OOM crash details from Application Metrics to Runtime Issues.
  • Clarify memory and swap interpretation in Application Metrics.
  • Refresh the Container Sizes page with a cleaner table and explicit container limits.
  • Update related links and references around alerts, metrics, and container sizes.

@benjaminach benjaminach requested review from Frzk and leo-scalingo May 5, 2026 16:38
@benjaminach benjaminach changed the title Document OOM Crashes Improve Application Memory Documentation May 11, 2026
@benjaminach benjaminach marked this pull request as ready for review May 11, 2026 21:20
Copy link
Copy Markdown
Member

@leo-scalingo leo-scalingo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes

- Uncaught exception in your code (especially with non-compiled languages)
- Insufficient resources
- Insufficient resources, such as an Out of Memory (OOM) crash when the
application consumes all its allocated memory
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
application consumes all its allocated memory
application consumes all its available memory

This can have several observable consequences:

- Abrupt termination: the application stops without a graceful shutdown process.
- Automatic restart: the container restarts according to its configuration.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Automatic restart: the container restarts according to its configuration.
- Automatic restart: the container is restarted following our [runtime error recovery process](#recovering-from-a-runtime-error).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants